tastytea
/
register-quicknav
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Change namespace separator from / to - to conform with MELPA rules.

This commit is contained in:
tastytea 2020-03-01 06:42:50 +01:00
parent 52dac539a6
commit 0111ede155
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
2 changed files with 53 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,7 +1,7 @@
# register-quicknav - Quickly jump to next/previous register # register-quicknav - Quickly jump to next/previous register
*Author:* tastytea <tastytea@tastytea.de><br> *Author:* tastytea <tastytea@tastytea.de><br>
*Version:* 0.1.0<br> *Version:* 0.1.1<br>
*URL:* [https://schlomp.space/tastytea/register-quicknav](https://schlomp.space/tastytea/register-quicknav)<br> *URL:* [https://schlomp.space/tastytea/register-quicknav](https://schlomp.space/tastytea/register-quicknav)<br>
This package is built on top of `register.el` and allows you to quickly jump This package is built on top of `register.el` and allows you to quickly jump
@ -20,20 +20,24 @@ you close and reopen it, it won't work anymore.
## Installation ## Installation
**Note:** The function and variable names were previously separated by “/”
from the namespace. To conform with MELPA rules the separator has been
changed to “-”.
To use `register-quicknav.el`, put it in your load-path and add the following To use `register-quicknav.el`, put it in your load-path and add the following
to your init.el: to your init.el:
(require 'register-quicknav) (require 'register-quicknav)
(global-set-key (kbd "<C-f5>") #'register-quicknav/prev-register) (global-set-key (kbd "<C-f5>") #'register-quicknav-prev-register)
(global-set-key (kbd "<C-f6>") #'register-quicknav/next-register) (global-set-key (kbd "<C-f6>") #'register-quicknav-next-register)
(global-set-key (kbd "M-r") #'register-quicknav/clear-current-register) (global-set-key (kbd "M-r") #'register-quicknav-clear-current-register)
Or, with use-package: Or, with use-package:
(use-package register-quicknav (use-package register-quicknav
:bind (("C-<f5>" . register-quicknav/prev-register) :bind (("C-<f5>" . register-quicknav-prev-register)
("C-<f6>" . register-quicknav/next-register) ("C-<f6>" . register-quicknav-next-register)
("M-r" . register-quicknav/clear-current-register))) ("M-r" . register-quicknav-clear-current-register)))
Instead of manually copying `register-quicknav.el` into your load-path, you Instead of manually copying `register-quicknav.el` into your load-path, you
can use [quelpa](https://github.com/quelpa/quelpa): can use [quelpa](https://github.com/quelpa/quelpa):
@ -44,7 +48,7 @@ can use [quelpa](https://github.com/quelpa/quelpa):
## Variables ## Variables
* `register-quicknav/buffer-only`: Cycle only through position registers in * `register-quicknav-buffer-only`: Cycle only through position registers in
current buffer. current buffer.

70
register-quicknav.el
View File

@ -3,7 +3,7 @@
;; Copyright (C) 2020 tastytea ;; Copyright (C) 2020 tastytea
;; Author: tastytea <tastytea@tastytea.de> ;; Author: tastytea <tastytea@tastytea.de>
;; Version: 0.1.0 ;; Version: 0.1.1
;; Package-Requires: ((emacs "24")) ;; Package-Requires: ((emacs "24"))
;; Keywords: convenience ;; Keywords: convenience
;; URL: https://schlomp.space/tastytea/register-quicknav ;; URL: https://schlomp.space/tastytea/register-quicknav
@ -39,20 +39,24 @@
;; Installation: ;; Installation:
;; ;;
;; **Note:** The function and variable names were previously separated by “/”
;; from the namespace. To conform with MELPA rules the separator has been
;; changed to “-”.
;;
;; To use `register-quicknav.el', put it in your load-path and add the following ;; To use `register-quicknav.el', put it in your load-path and add the following
;; to your init.el: ;; to your init.el:
;; ;;
;; (require 'register-quicknav) ;; (require 'register-quicknav)
;; (global-set-key (kbd "<C-f5>") #'register-quicknav/prev-register) ;; (global-set-key (kbd "<C-f5>") #'register-quicknav-prev-register)
;; (global-set-key (kbd "<C-f6>") #'register-quicknav/next-register) ;; (global-set-key (kbd "<C-f6>") #'register-quicknav-next-register)
;; (global-set-key (kbd "M-r") #'register-quicknav/clear-current-register) ;; (global-set-key (kbd "M-r") #'register-quicknav-clear-current-register)
;; ;;
;; Or, with use-package: ;; Or, with use-package:
;; ;;
;; (use-package register-quicknav ;; (use-package register-quicknav
;; :bind (("C-<f5>" . register-quicknav/prev-register) ;; :bind (("C-<f5>" . register-quicknav-prev-register)
;; ("C-<f6>" . register-quicknav/next-register) ;; ("C-<f6>" . register-quicknav-next-register)
;; ("M-r" . register-quicknav/clear-current-register))) ;; ("M-r" . register-quicknav-clear-current-register)))
;; ;;
;; Instead of manually copying `register-quicknav.el' into your load-path, you ;; Instead of manually copying `register-quicknav.el' into your load-path, you
;; can use [quelpa](https://github.com/quelpa/quelpa): ;; can use [quelpa](https://github.com/quelpa/quelpa):
@ -63,24 +67,33 @@
;; Variables: ;; Variables:
;; ;;
;; * `register-quicknav/buffer-only': Cycle only through position registers in ;; * `register-quicknav-buffer-only': Cycle only through position registers in
;; current buffer. ;; current buffer.
;;; Code: ;;; Code:
(define-obsolete-variable-alias 'register-quicknav/buffer-only
'register-quicknav-buffer-only "0.1.1")
(define-obsolete-function-alias #'register-quicknav/next-register
#'register-quicknav-next-register "0.1.1")
(define-obsolete-function-alias #'register-quicknav/prev-register
#'register-quicknav-prev-register "0.1.1")
(define-obsolete-function-alias #'register-quicknav/clear-current-register
#'register-quicknav-clear-current-register "0.1.1")
(defgroup register-quicknav nil (defgroup register-quicknav nil
"Variables for register-quicknav." "Variables for register-quicknav."
:group 'editing) :group 'editing)
(defcustom register-quicknav/buffer-only nil (defcustom register-quicknav-buffer-only nil
"Cycle only through position registers in current buffer." "Cycle only through position registers in current buffer."
:type 'boolean :type 'boolean
:group 'register-quicknav) :group 'register-quicknav)
(defvar register-quicknav//current-position-register 0 (defvar register-quicknav--current-position-register 0
"An index to the current position register.") "An index to the current position register.")
(defun register-quicknav//sort-position-register-elements (a b) (defun register-quicknav--sort-position-register-elements (a b)
"Return t if the file name is the same and A < B." "Return t if the file name is the same and A < B."
(let ((marker-a (cdr a)) (let ((marker-a (cdr a))
(marker-b (cdr b))) (marker-b (cdr b)))
@ -89,55 +102,54 @@
(< (marker-position marker-a) (< (marker-position marker-a)
(marker-position marker-b))))) (marker-position marker-b)))))
(defun register-quicknav//registers () (defun register-quicknav--registers ()
"Return all position registers, sorted by file name and position. "Return all position registers, sorted by file name and position.
If `register-quicknav/buffer-only' is t, return only registers in If `register-quicknav-buffer-only' is t, return only registers in
current buffer." current buffer."
(let (result) (let (result)
(dolist (item register-alist) (dolist (item register-alist)
(when (markerp (cdr item)) (when (markerp (cdr item))
(if register-quicknav/buffer-only (if register-quicknav-buffer-only
(when (eq (current-buffer) (marker-buffer (cdr item))) (when (eq (current-buffer) (marker-buffer (cdr item)))
(setq result (cons item result))) (setq result (cons item result)))
(setq result (cons item result))))) (setq result (cons item result)))))
(sort result #'register-quicknav//sort-position-register-elements))) (sort result #'register-quicknav--sort-position-register-elements)))
;;;###autoload ;;;###autoload
(defun register-quicknav/next-register () (defun register-quicknav-next-register ()
"Jump to next position register." "Jump to next position register."
(interactive) (interactive)
(let ((pos register-quicknav//current-position-register) (let ((pos register-quicknav--current-position-register)
(registers (register-quicknav//registers))) (registers (register-quicknav--registers)))
(setq pos (+ pos 1)) (setq pos (+ pos 1))
(when (>= pos (length registers)) (when (>= pos (length registers))
(setq pos 0)) (setq pos 0))
(setq register-quicknav//current-position-register pos) (setq register-quicknav--current-position-register pos)
(register-to-point (car (nth pos registers))))) (register-to-point (car (nth pos registers)))))
;;;###autoload ;;;###autoload
(defun register-quicknav/prev-register () (defun register-quicknav-prev-register ()
"Jump to previous position register." "Jump to previous position register."
(interactive) (interactive)
(let ((pos register-quicknav//current-position-register) (let ((pos register-quicknav--current-position-register)
(registers (register-quicknav//registers))) (registers (register-quicknav--registers)))
(setq pos (- pos 1)) (setq pos (- pos 1))
(when (< pos 0) (when (< pos 0)
(setq pos (- (length registers) 1))) (setq pos (- (length registers) 1)))
(setq register-quicknav//current-position-register pos) (setq register-quicknav--current-position-register pos)
(register-to-point (car (nth pos registers))))) (register-to-point (car (nth pos registers)))))
;;;###autoload ;;;###autoload
(defun register-quicknav/clear-current-register () (defun register-quicknav-clear-current-register ()
"Clear currently selected position register. "Clear currently selected position register.
To be more precise, it deletes the To be more precise, it deletes the
`register-quicknav//current-position-register'th position `register-quicknav--current-position-register'th position
register, as reported by `register-quicknav//registers', from register, as reported by `register-quicknav--registers', from
`register-alist'." `register-alist'."
(interactive) (interactive)
(let ((pos register-quicknav//current-position-register) (let ((pos register-quicknav--current-position-register)
(registers (register-quicknav//registers))) (registers (register-quicknav--registers)))
(setq register-alist (delq (nth pos registers) register-alist)))) (setq register-alist (delq (nth pos registers) register-alist))))
(provide 'register-quicknav) (provide 'register-quicknav)
;;; register-quicknav.el ends here ;;; register-quicknav.el ends here