annotate lisp/scroll-lock.el @ 97681:5da85bdafc91

(fortran-tab-mode-string, fortran-comment-line-start) (fortran-continuation-string): Doc fixes.
author Glenn Morris <rgm@gnu.org>
date Sat, 23 Aug 2008 23:21:31 +0000
parents ee5932bf781d
children a9dc0e7c3f2b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
65035
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 ;;; scroll-lock.el --- Scroll lock scrolling.
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2
79721
73661ddc7ac7 Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 78236
diff changeset
3 ;; Copyright (C) 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
65035
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 ;; Author: Ralf Angeli <angeli@iwi.uni-sb.de>
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 ;; Maintainer: FSF
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 ;; Created: 2005-06-18
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
65035
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
13 ;; the Free Software Foundation, either version 3 of the License, or
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
14 ;; (at your option) any later version.
65035
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
65035
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 ;;; Commentary:
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 ;; By activating Scroll Lock mode, keys for moving point by line or
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 ;; paragraph will scroll the buffer by the respective amount of lines
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 ;; instead. Point will be kept vertically fixed relative to window
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 ;; boundaries.
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 ;;; Code:
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 (defvar scroll-lock-mode-map
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 (let ((map (make-sparse-keymap)))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 (define-key map [remap next-line] 'scroll-lock-next-line)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 (define-key map [remap previous-line] 'scroll-lock-previous-line)
65038
588913d78aaf Fix errors due to incorrect line wrapping.
Kim F. Storm <storm@cua.dk>
parents: 65035
diff changeset
37 (define-key map [remap forward-paragraph] 'scroll-lock-forward-paragraph)
588913d78aaf Fix errors due to incorrect line wrapping.
Kim F. Storm <storm@cua.dk>
parents: 65035
diff changeset
38 (define-key map [remap backward-paragraph] 'scroll-lock-backward-paragraph)
65035
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 map)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 "Keymap for Scroll Lock mode.")
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 (defvar scroll-lock-preserve-screen-pos-save scroll-preserve-screen-position
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 "Used for saving the state of `scroll-preserve-screen-position'.")
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 (make-variable-buffer-local 'scroll-lock-preserve-screen-pos-save)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 (defvar scroll-lock-temporary-goal-column 0
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 "Like `temporary-goal-column' but for scroll-lock-* commands.")
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 ;;;###autoload
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 (define-minor-mode scroll-lock-mode
78002
a55abbc28a7f (scroll-lock-mode): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 75347
diff changeset
51 "Buffer-local minor mode for pager-like scrolling.
65035
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 Keys which normally move point by line or paragraph will scroll
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 the buffer by the respective amount of lines instead and point
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 will be kept vertically fixed relative to window boundaries
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 during scrolling."
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 :lighter " ScrLck"
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 :keymap scroll-lock-mode-map
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 (if scroll-lock-mode
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 (progn
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 (setq scroll-lock-preserve-screen-pos-save
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 scroll-preserve-screen-position)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 (set (make-local-variable 'scroll-preserve-screen-position) 'always))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 (setq scroll-preserve-screen-position
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 scroll-lock-preserve-screen-pos-save)))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 (defun scroll-lock-update-goal-column ()
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 "Update `scroll-lock-temporary-goal-column' if necessary."
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 (unless (memq last-command '(scroll-lock-next-line
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 scroll-lock-previous-line
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 scroll-lock-forward-paragraph
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 scroll-lock-backward-paragraph))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 (setq scroll-lock-temporary-goal-column (current-column))))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 (defun scroll-lock-move-to-column (column)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 "Like `move-to-column' but cater for wrapped lines."
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 (if (or (bolp)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 ;; Start of a screen line.
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78 (not (zerop (mod (- (point) (line-beginning-position))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 (window-width)))))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 (move-to-column column)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 (forward-char (min column (- (line-end-position) (point))))))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83 (defun scroll-lock-next-line (&optional arg)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 "Scroll up ARG lines keeping point fixed."
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 (interactive "p")
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86 (or arg (setq arg 1))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87 (scroll-lock-update-goal-column)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88 (if (pos-visible-in-window-p (point-max))
85478
786d3a985758 * term/x-win.el (x-gtk-stock-map, icon-map-list)
Dan Nicolaescu <dann@ics.uci.edu>
parents: 78236
diff changeset
89 (forward-line arg)
65035
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90 (scroll-up arg))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91 (scroll-lock-move-to-column scroll-lock-temporary-goal-column))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93 (defun scroll-lock-previous-line (&optional arg)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 "Scroll up ARG lines keeping point fixed."
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95 (interactive "p")
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 (or arg (setq arg 1))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 (scroll-lock-update-goal-column)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98 (condition-case nil
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 (scroll-down arg)
85478
786d3a985758 * term/x-win.el (x-gtk-stock-map, icon-map-list)
Dan Nicolaescu <dann@ics.uci.edu>
parents: 78236
diff changeset
100 (beginning-of-buffer (forward-line (- arg))))
65035
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 (scroll-lock-move-to-column scroll-lock-temporary-goal-column))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 (defun scroll-lock-forward-paragraph (&optional arg)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 "Scroll down ARG paragraphs keeping point fixed."
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 (interactive "p")
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 (or arg (setq arg 1))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107 (scroll-lock-update-goal-column)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108 (scroll-up (count-screen-lines (point) (save-excursion
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109 (forward-paragraph arg)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110 (point))))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111 (scroll-lock-move-to-column scroll-lock-temporary-goal-column))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 (defun scroll-lock-backward-paragraph (&optional arg)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114 "Scroll up ARG paragraphs keeping point fixed."
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 (interactive "p")
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
116 (or arg (setq arg 1))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117 (scroll-lock-update-goal-column)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118 (let ((goal (save-excursion (backward-paragraph arg) (point))))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 (condition-case nil
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 (scroll-down (count-screen-lines goal (point)))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 (beginning-of-buffer (goto-char goal))))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 (scroll-lock-move-to-column scroll-lock-temporary-goal-column))
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 (provide 'scroll-lock)
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125
65125
bb897fec166c Add arch tagline
Miles Bader <miles@gnu.org>
parents: 65038
diff changeset
126 ;; arch-tag: 148fc8e8-67e0-4638-bb34-3291595ab7e1
65035
126c81827d58 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 ;;; scroll-lock.el ends here