summaryrefslogtreecommitdiff
path: root/modes/scroll-lock/evil-collection-scroll-lock.el
blob: ae81b1030c2063fb1f8afbbfcf0560a8a3355489 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
;;; evil-collection-scroll-lock.el --- Bindings for `scroll-lock' -*- lexical-binding: t -*-

;; Copyright (C) 2021 James Nguyen

;; Author: James Nguyen <james@jojojames.com>
;; Maintainer: James Nguyen <james@jojojames.com>
;; URL: https://github.com/emacs-evil/evil-collection
;; Version: 0.0.1
;; Package-Requires: ((emacs "26.3"))
;; Keywords: evil, elisp, lisp

;; This program 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.

;; This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:
;;; Bindings for `scroll-lock'.

;;; Code:
(require 'scroll-lock)
(require 'evil-collection)

(declare-function scroll-lock-next-line "scroll-lock")
(declare-function scroll-lock-previous-line "scroll-lock")
(declare-function scroll-lock-forward-paragraph "scroll-lock")
(declare-function scroll-lock-backward-paragraph "scroll-lock")

(defconst evil-collection-scroll-lock-maps '(scroll-lock-mode-map))

(evil-define-motion evil-collection-scroll-lock-next-line (count)
  "Scroll down COUNT lines keeping point fixed."
  :type line
  (let (line-move-visual)
    (scroll-lock-next-line (or count 1))))

(evil-define-motion evil-collection-scroll-lock-previous-line (count)
  "Scroll up COUNT lines keeping point fixed."
  :type line
  (let (line-move-visual)
    (scroll-lock-previous-line (or count 1))))

(evil-define-motion evil-collection-scroll-lock-forward-paragraph (count)
  "Scroll down COUNT paragraphs keeping point fixed."
  :jump t
  :type exclusive
  (evil-signal-at-bob-or-eob count)
  (scroll-lock-forward-paragraph count)
  (unless (eobp) (forward-line)))

(evil-define-motion evil-collection-scroll-lock-backward-paragraph (count)
  "Scroll up COUNT paragraphs keeping point fixed."
  :jump t
  :type exclusive
  (evil-signal-at-bob-or-eob (- (or count 1)))
  (unless (eobp) (forward-line))
  (scroll-lock-backward-paragraph count)
  (unless (bobp) (forward-line -1)))

;;;###autoload
(defun evil-collection-scroll-lock-setup ()
  "Set up `evil' bindings for `scroll-lock'."
  (evil-collection-define-key 'normal 'scroll-lock-mode-map
    [remap evil-next-line] 'evil-collection-scroll-lock-next-line
    [remap evil-previous-line] 'evil-collection-scroll-lock-previous-line
    [remap evil-forward-paragraph]
    'evil-collection-scroll-lock-forward-paragraph
    [remap evil-backward-paragraph]
    'evil-collection-scroll-lock-backward-paragraph)

  (evil-add-command-properties
   #'evil-collection-scroll-lock-forward-paragraph :jump t)
  (evil-add-command-properties
   #'evil-collection-scroll-lock-backward-paragraph :jump t)

  (add-hook 'scroll-lock-mode-hook 'evil-normalize-keymaps))

(provide 'evil-collection-scroll-lock)
;;; evil-collection-scroll-lock.el ends here