1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-25 10:47:00 +00:00
emacs/lisp/scroll-lock.el
Glenn Morris e1ac4066d1 Minor-mode doc fixes for ARG behavior
* lisp/completion.el (dynamic-completion-mode):
* lisp/dirtrack.el (dirtrack-debug-mode):
* lisp/electric.el (electric-layout-mode):
* lisp/epa-mail.el (epa-mail-mode, epa-global-mail-mode):
* lisp/face-remap.el (text-scale-mode, buffer-face-mode):
* lisp/iimage.el (iimage-mode):
* lisp/image-mode.el (image-transform-mode):
* lisp/minibuffer.el (completion-in-region-mode):
* lisp/scroll-lock.el (scroll-lock-mode):
* lisp/simple.el (next-error-follow-minor-mode):
* lisp/tar-mode.el (tar-subfile-mode):
* lisp/tooltip.el (tooltip-mode):
* lisp/vcursor.el (vcursor-use-vcursor-map):
* lisp/wid-browse.el (widget-minor-mode):
* lisp/emulation/tpu-edt.el (tpu-edt-mode):
* lisp/emulation/tpu-extras.el (tpu-cursor-free-mode):
* lisp/international/iso-ascii.el (iso-ascii-mode):
* lisp/language/thai-util.el (thai-word-mode):
* lisp/mail/supercite.el (sc-minor-mode):
* lisp/net/goto-addr.el (goto-address-mode):
* lisp/net/rcirc.el (rcirc-multiline-minor-mode, rcirc-track-minor-mode):
* lisp/progmodes/cwarn.el (cwarn-mode):
* lisp/progmodes/flymake.el (flymake-mode):
* lisp/progmodes/glasses.el (glasses-mode):
* lisp/progmodes/hideshow.el (hs-minor-mode):
* lisp/progmodes/pascal.el (pascal-outline-mode):
* lisp/textmodes/enriched.el (enriched-mode):
* lisp/vc/smerge-mode.el (smerge-mode):
Doc fixes (minor mode argument).

* etc/NEWS: Related markup.
2012-02-07 21:12:24 -05:00

129 lines
4.7 KiB
EmacsLisp

;;; scroll-lock.el --- Scroll lock scrolling.
;; Copyright (C) 2005-2012 Free Software Foundation, Inc.
;; Author: Ralf Angeli <angeli@iwi.uni-sb.de>
;; Maintainer: FSF
;; Created: 2005-06-18
;; 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
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; By activating Scroll Lock mode, keys for moving point by line or
;; paragraph will scroll the buffer by the respective amount of lines
;; instead. Point will be kept vertically fixed relative to window
;; boundaries.
;;; Code:
(defvar scroll-lock-mode-map
(let ((map (make-sparse-keymap)))
(define-key map [remap next-line] 'scroll-lock-next-line)
(define-key map [remap previous-line] 'scroll-lock-previous-line)
(define-key map [remap forward-paragraph] 'scroll-lock-forward-paragraph)
(define-key map [remap backward-paragraph] 'scroll-lock-backward-paragraph)
map)
"Keymap for Scroll Lock mode.")
(defvar scroll-lock-preserve-screen-pos-save scroll-preserve-screen-position
"Used for saving the state of `scroll-preserve-screen-position'.")
(make-variable-buffer-local 'scroll-lock-preserve-screen-pos-save)
(defvar scroll-lock-temporary-goal-column 0
"Like `temporary-goal-column' but for scroll-lock-* commands.")
;;;###autoload
(define-minor-mode scroll-lock-mode
"Buffer-local minor mode for pager-like scrolling.
With a prefix argument ARG, enable the mode if ARG is positive,
and disable it otherwise. If called from Lisp, enable the mode
if ARG is omitted or nil. When enabled, keys that normally move
point by line or paragraph will scroll the buffer by the
respective amount of lines instead and point will be kept
vertically fixed relative to window boundaries during scrolling."
:lighter " ScrLck"
:keymap scroll-lock-mode-map
(if scroll-lock-mode
(progn
(setq scroll-lock-preserve-screen-pos-save
scroll-preserve-screen-position)
(set (make-local-variable 'scroll-preserve-screen-position) 'always))
(setq scroll-preserve-screen-position
scroll-lock-preserve-screen-pos-save)))
(defun scroll-lock-update-goal-column ()
"Update `scroll-lock-temporary-goal-column' if necessary."
(unless (memq last-command '(scroll-lock-next-line
scroll-lock-previous-line
scroll-lock-forward-paragraph
scroll-lock-backward-paragraph))
(setq scroll-lock-temporary-goal-column (current-column))))
(defun scroll-lock-move-to-column (column)
"Like `move-to-column' but cater for wrapped lines."
(if (or (bolp)
;; Start of a screen line.
(not (zerop (mod (- (point) (line-beginning-position))
(window-width)))))
(move-to-column column)
(forward-char (min column (- (line-end-position) (point))))))
(defun scroll-lock-next-line (&optional arg)
"Scroll up ARG lines keeping point fixed."
(interactive "p")
(or arg (setq arg 1))
(scroll-lock-update-goal-column)
(if (pos-visible-in-window-p (point-max))
(forward-line arg)
(scroll-up arg))
(scroll-lock-move-to-column scroll-lock-temporary-goal-column))
(defun scroll-lock-previous-line (&optional arg)
"Scroll up ARG lines keeping point fixed."
(interactive "p")
(or arg (setq arg 1))
(scroll-lock-update-goal-column)
(condition-case nil
(scroll-down arg)
(beginning-of-buffer (forward-line (- arg))))
(scroll-lock-move-to-column scroll-lock-temporary-goal-column))
(defun scroll-lock-forward-paragraph (&optional arg)
"Scroll down ARG paragraphs keeping point fixed."
(interactive "p")
(or arg (setq arg 1))
(scroll-lock-update-goal-column)
(scroll-up (count-screen-lines (point) (save-excursion
(forward-paragraph arg)
(point))))
(scroll-lock-move-to-column scroll-lock-temporary-goal-column))
(defun scroll-lock-backward-paragraph (&optional arg)
"Scroll up ARG paragraphs keeping point fixed."
(interactive "p")
(or arg (setq arg 1))
(scroll-lock-update-goal-column)
(let ((goal (save-excursion (backward-paragraph arg) (point))))
(condition-case nil
(scroll-down (count-screen-lines goal (point)))
(beginning-of-buffer (goto-char goal))))
(scroll-lock-move-to-column scroll-lock-temporary-goal-column))
(provide 'scroll-lock)
;;; scroll-lock.el ends here