197 lines
7.1 KiB
EmacsLisp
197 lines
7.1 KiB
EmacsLisp
;;; register-quicknav.el --- Quickly jump to next/previous register -*- lexical-binding: t; -*-
|
|
|
|
;; Copyright (C) 2020 tastytea
|
|
|
|
;; Author: tastytea <tastytea@tastytea.de>
|
|
;; Version: 0.2.0
|
|
;; Package-Requires: ((emacs "24.3"))
|
|
;; Keywords: convenience
|
|
;; URL: https://schlomp.space/tastytea/register-quicknav
|
|
|
|
;; 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 <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; This package is built on top of `register.el' and allows you to quickly jump
|
|
;; to the next/previous position register. If you reach the end, the search
|
|
;; wraps around and continues with the first (or last) register.
|
|
|
|
;; Features:
|
|
;;
|
|
;; * Cycle through all position registers in both directions.
|
|
;; * Clear current register.
|
|
|
|
;; 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 your init.el:
|
|
;;
|
|
;; (require 'register-quicknav)
|
|
;; (global-set-key (kbd "<C-f5>") #'register-quicknav-prev-register)
|
|
;; (global-set-key (kbd "<C-f6>") #'register-quicknav-next-register)
|
|
;; (global-set-key (kbd "M-r") #'register-quicknav-clear-current-register)
|
|
;;
|
|
;; Or, with use-package:
|
|
;;
|
|
;; (use-package register-quicknav
|
|
;; :bind (("C-<f5>" . register-quicknav-prev-register)
|
|
;; ("C-<f6>" . register-quicknav-next-register)
|
|
;; ("M-r" . register-quicknav-clear-current-register)))
|
|
;;
|
|
;; Instead of manually copying `register-quicknav.el' into your load-path, you
|
|
;; can use [quelpa](https://github.com/quelpa/quelpa):
|
|
;;
|
|
;; (quelpa '(register-quicknav
|
|
;; :fetcher git
|
|
;; :url "https://schlomp.space/tastytea/register-quicknav.git"))
|
|
|
|
;; Variables:
|
|
;;
|
|
;; * `register-quicknav-buffer-only': Cycle only through position registers in
|
|
;; current buffer.
|
|
|
|
;;; Code:
|
|
|
|
(require 'cl-lib)
|
|
|
|
(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
|
|
"Variables for register-quicknav."
|
|
:group 'editing)
|
|
|
|
(defcustom register-quicknav-buffer-only nil
|
|
"Cycle only through position registers in current buffer."
|
|
:type 'boolean
|
|
:group 'register-quicknav)
|
|
|
|
(defvar register-quicknav--last-register nil
|
|
"The last jumped-to position register.")
|
|
|
|
(defun register-quicknav--item-file-name (item)
|
|
"Return file-name of ITEM.
|
|
Works on markers and file-queries."
|
|
(if (markerp (cdr item))
|
|
(buffer-file-name (marker-buffer (cdr item)))
|
|
(nth 2 item)))
|
|
|
|
(defun register-quicknav--is-current-buffer? (item)
|
|
"Return t if ITEM is in current buffer.
|
|
Works on markers and file-queries."
|
|
(if (markerp (cdr item))
|
|
(eq (current-buffer) (marker-buffer (cdr item)))
|
|
(string= (buffer-file-name (current-buffer))
|
|
(register-quicknav--item-file-name item))))
|
|
|
|
(defun register-quicknav--item-position (item)
|
|
"Return position of ITEM.
|
|
Works on markers and file-queries."
|
|
(if (markerp (cdr item))
|
|
(marker-position (cdr item))
|
|
(nth 3 item)))
|
|
|
|
(defun register-quicknav--registers ()
|
|
"Return all position registers, sorted by file name and position.
|
|
If `register-quicknav-buffer-only' is t, return only registers in
|
|
current buffer."
|
|
(cl-flet ((sort-registers
|
|
(lambda (a b)
|
|
"Return t if position of A is < B.
|
|
Works on markers and file-queries."
|
|
(and (string= (register-quicknav--item-file-name a)
|
|
(register-quicknav--item-file-name b))
|
|
(< (register-quicknav--item-position a)
|
|
(register-quicknav--item-position b))))))
|
|
(let ((result))
|
|
(dolist (item register-alist)
|
|
(if (or (markerp (cdr item))
|
|
(eq (nth 1 item) 'file-query))
|
|
(if register-quicknav-buffer-only
|
|
(when (register-quicknav--is-current-buffer? item)
|
|
(push item result))
|
|
(push item result))))
|
|
(sort result #'sort-registers))))
|
|
|
|
(defun register-quicknav--jump-to-register (next)
|
|
"Jump to next position register if NEXT is t, to previous otherwise."
|
|
(let* ((registers (register-quicknav--registers))
|
|
(index (cl-position register-quicknav--last-register registers))
|
|
(stop-searching))
|
|
(unless (eq index nil)
|
|
(if next
|
|
(cl-decf index)
|
|
(cl-incf index)))
|
|
|
|
;; Try to find the position register closest to point.
|
|
(dolist (item registers)
|
|
(when (register-quicknav--is-current-buffer? item)
|
|
(let ((item-pos (register-quicknav--item-position item)))
|
|
(if next
|
|
(when (<= item-pos (point))
|
|
(setq index (cl-position item registers)))
|
|
(when (and (not stop-searching) (>= item-pos (point)))
|
|
(setq index (cl-position item registers)
|
|
stop-searching t))))))
|
|
|
|
;; If an index was found, set it to the next/previous register. If not, set
|
|
;; it to the first/last.
|
|
(if index
|
|
(progn
|
|
(when (> index (- (length registers) 1))
|
|
(setq index nil))
|
|
(if next
|
|
(progn
|
|
(if (or (eq index nil) (eq index (- (length registers) 1)))
|
|
(setq index 0)
|
|
(cl-incf index)))
|
|
(if (or (eq index nil) (eq index 0))
|
|
(setq index (- (length registers) 1))
|
|
(cl-decf index)))
|
|
(register-to-point (car (nth index registers)))
|
|
(setq register-quicknav--last-register (nth index registers)))
|
|
(register-to-point (car (car registers)))
|
|
(setq register-quicknav--last-register (car registers)))))
|
|
|
|
;;;###autoload
|
|
(defun register-quicknav-next-register ()
|
|
"Jump to next position register."
|
|
(interactive)
|
|
(register-quicknav--jump-to-register t))
|
|
|
|
;;;###autoload
|
|
(defun register-quicknav-prev-register ()
|
|
"Jump to previous position register."
|
|
(interactive)
|
|
(register-quicknav--jump-to-register nil))
|
|
|
|
;;;###autoload
|
|
(defun register-quicknav-clear-current-register ()
|
|
"Clear last jumped-to position register from `register-alist'."
|
|
(interactive)
|
|
(setq register-alist (delq register-quicknav--last-register register-alist)))
|
|
|
|
(provide 'register-quicknav)
|
|
;;; register-quicknav.el ends here
|