2020-02-20 13:51:00 +01:00
|
|
|
;;; register-quicknav.el --- Quickly jump to next/previous register -*- lexical-binding: t; -*-
|
2020-02-19 15:58:45 +01:00
|
|
|
|
|
|
|
;; Copyright (C) 2020 tastytea
|
|
|
|
|
|
|
|
;; Author: tastytea <tastytea@tastytea.de>
|
2020-03-12 17:31:36 +01:00
|
|
|
;; Version: 0.3.2
|
2020-03-02 10:16:13 +01:00
|
|
|
;; Package-Requires: ((emacs "24.3"))
|
2020-02-20 01:50:04 +01:00
|
|
|
;; Keywords: convenience
|
2020-02-19 19:23:16 +01:00
|
|
|
;; URL: https://schlomp.space/tastytea/register-quicknav
|
2020-02-19 15:58:45 +01:00
|
|
|
|
|
|
|
;; 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:
|
|
|
|
|
2020-02-19 17:02:54 +01:00
|
|
|
;; 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
|
2020-03-08 12:17:05 +01:00
|
|
|
;; wraps around and continues with the first (or last) register. It can be used
|
|
|
|
;; across all files or individually for each buffer.
|
2020-02-19 15:58:45 +01:00
|
|
|
|
|
|
|
;; Features:
|
|
|
|
;;
|
|
|
|
;; * Cycle through all position registers in both directions.
|
2020-02-19 16:48:18 +01:00
|
|
|
;; * Clear current register.
|
2020-02-19 15:58:45 +01:00
|
|
|
|
|
|
|
;; Installation:
|
|
|
|
;;
|
2020-03-01 06:42:50 +01:00
|
|
|
;; **Note:** The function and variable names were previously separated by “/”
|
|
|
|
;; from the namespace. To conform with MELPA rules the separator has been
|
|
|
|
;; changed to “-”.
|
|
|
|
;;
|
2020-03-15 21:10:15 +01:00
|
|
|
;; To use `register-quicknav.el', get it from
|
|
|
|
;; [MELPA](https://melpa.org/#/register-quicknav) or put it in your load-path
|
|
|
|
;; and add the following to your init.el:
|
2020-02-19 15:58:45 +01:00
|
|
|
;;
|
|
|
|
;; (require 'register-quicknav)
|
2020-03-01 06:42:50 +01:00
|
|
|
;; (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)
|
2020-02-19 15:58:45 +01:00
|
|
|
;;
|
|
|
|
;; Or, with use-package:
|
|
|
|
;;
|
|
|
|
;; (use-package register-quicknav
|
2020-03-01 06:42:50 +01:00
|
|
|
;; :bind (("C-<f5>" . register-quicknav-prev-register)
|
|
|
|
;; ("C-<f6>" . register-quicknav-next-register)
|
|
|
|
;; ("M-r" . register-quicknav-clear-current-register)))
|
2020-02-19 15:58:45 +01:00
|
|
|
|
2020-02-20 03:25:36 +01:00
|
|
|
;; Variables:
|
2020-02-19 19:00:30 +01:00
|
|
|
;;
|
2020-03-01 06:42:50 +01:00
|
|
|
;; * `register-quicknav-buffer-only': Cycle only through position registers in
|
2020-03-12 17:31:36 +01:00
|
|
|
;; current buffer. Can be safely set as file- and/or dir-local variable.
|
2020-02-19 19:00:30 +01:00
|
|
|
|
2020-02-19 15:58:45 +01:00
|
|
|
;;; Code:
|
|
|
|
|
2020-03-02 10:16:13 +01:00
|
|
|
(require 'cl-lib)
|
|
|
|
|
2020-03-01 06:42:50 +01:00
|
|
|
(define-obsolete-variable-alias 'register-quicknav/buffer-only
|
|
|
|
'register-quicknav-buffer-only "0.1.1")
|
2020-03-02 09:41:22 +01:00
|
|
|
(define-obsolete-function-alias 'register-quicknav/next-register
|
2020-03-01 06:42:50 +01:00
|
|
|
#'register-quicknav-next-register "0.1.1")
|
2020-03-02 09:41:22 +01:00
|
|
|
(define-obsolete-function-alias 'register-quicknav/prev-register
|
2020-03-01 06:42:50 +01:00
|
|
|
#'register-quicknav-prev-register "0.1.1")
|
2020-03-02 09:41:22 +01:00
|
|
|
(define-obsolete-function-alias 'register-quicknav/clear-current-register
|
2020-03-01 06:42:50 +01:00
|
|
|
#'register-quicknav-clear-current-register "0.1.1")
|
|
|
|
|
2020-02-20 03:25:36 +01:00
|
|
|
(defgroup register-quicknav nil
|
|
|
|
"Variables for register-quicknav."
|
|
|
|
:group 'editing)
|
|
|
|
|
2020-03-08 12:28:45 +01:00
|
|
|
;;;###autoload
|
2020-03-01 06:42:50 +01:00
|
|
|
(defcustom register-quicknav-buffer-only nil
|
2020-02-20 03:25:36 +01:00
|
|
|
"Cycle only through position registers in current buffer."
|
|
|
|
:type 'boolean
|
2020-03-08 12:28:45 +01:00
|
|
|
:group 'register-quicknav
|
|
|
|
:safe #'booleanp)
|
2020-02-20 03:25:36 +01:00
|
|
|
|
2020-03-15 20:54:08 +01:00
|
|
|
(defcustom register-quicknav-unused-registers-begin ?A
|
|
|
|
"Begin looking for unused register at this register."
|
|
|
|
:type 'character
|
|
|
|
:group 'register-quicknav)
|
|
|
|
|
|
|
|
(defcustom register-quicknav-unused-registers-end ?Z
|
|
|
|
"End looking for unused register at this register."
|
|
|
|
:type 'character
|
|
|
|
:group 'register-quicknav)
|
|
|
|
|
2020-03-08 04:12:00 +01:00
|
|
|
(defvar-local register-quicknav--last-register-v nil
|
2020-03-07 19:56:54 +01:00
|
|
|
"The last jumped-to position register.")
|
|
|
|
|
2020-03-08 04:12:00 +01:00
|
|
|
(defun register-quicknav--last-register (&optional val)
|
|
|
|
"Return `register-quicknav--last-register-v' or set it if VAL is non-nil.
|
|
|
|
Use the local value if `register-quicknav-buffer-only' is set and
|
|
|
|
the global value otherwise."
|
|
|
|
(if val
|
|
|
|
(if register-quicknav-buffer-only
|
|
|
|
(setq register-quicknav--last-register-v val)
|
|
|
|
(setq-default register-quicknav--last-register-v val))
|
|
|
|
(if register-quicknav-buffer-only
|
|
|
|
register-quicknav--last-register-v
|
|
|
|
(default-value 'register-quicknav--last-register-v))))
|
|
|
|
|
2020-03-08 05:45:03 +01:00
|
|
|
(defun register-quicknav--file-name (register)
|
2020-03-08 04:41:42 +01:00
|
|
|
"Return file-name of REGISTER.
|
2020-03-07 19:56:54 +01:00
|
|
|
Works on markers and file-queries."
|
2020-03-08 04:41:42 +01:00
|
|
|
(if (markerp (cdr register))
|
|
|
|
(buffer-file-name (marker-buffer (cdr register)))
|
|
|
|
(nth 2 register)))
|
2020-03-07 19:56:54 +01:00
|
|
|
|
2020-03-08 04:41:42 +01:00
|
|
|
(defun register-quicknav--is-current-buffer? (register)
|
|
|
|
"Return t if REGISTER is in current buffer.
|
2020-03-07 19:56:54 +01:00
|
|
|
Works on markers and file-queries."
|
2020-03-08 04:41:42 +01:00
|
|
|
(if (markerp (cdr register))
|
|
|
|
(eq (current-buffer) (marker-buffer (cdr register)))
|
2020-03-07 19:56:54 +01:00
|
|
|
(string= (buffer-file-name (current-buffer))
|
2020-03-08 05:45:03 +01:00
|
|
|
(register-quicknav--file-name register))))
|
2020-03-07 19:56:54 +01:00
|
|
|
|
2020-03-08 04:41:42 +01:00
|
|
|
(defun register-quicknav--position (register)
|
|
|
|
"Return position of REGISTER.
|
2020-03-07 19:56:54 +01:00
|
|
|
Works on markers and file-queries."
|
2020-03-08 04:41:42 +01:00
|
|
|
(if (markerp (cdr register))
|
|
|
|
(marker-position (cdr register))
|
|
|
|
(nth 3 register)))
|
2020-02-19 15:58:45 +01:00
|
|
|
|
2020-03-01 06:42:50 +01:00
|
|
|
(defun register-quicknav--registers ()
|
2020-02-20 03:30:51 +01:00
|
|
|
"Return all position registers, sorted by file name and position.
|
2020-03-01 06:42:50 +01:00
|
|
|
If `register-quicknav-buffer-only' is t, return only registers in
|
2020-02-20 03:30:51 +01:00
|
|
|
current buffer."
|
2020-03-07 19:56:54 +01:00
|
|
|
(cl-flet ((sort-registers
|
|
|
|
(lambda (a b)
|
|
|
|
"Return t if position of A is < B.
|
2020-03-07 15:14:32 +01:00
|
|
|
Works on markers and file-queries."
|
2020-03-08 05:45:03 +01:00
|
|
|
(and (string= (register-quicknav--file-name a)
|
|
|
|
(register-quicknav--file-name b))
|
2020-03-08 04:41:42 +01:00
|
|
|
(< (register-quicknav--position a)
|
|
|
|
(register-quicknav--position b))))))
|
2020-03-02 10:32:01 +01:00
|
|
|
(let ((result))
|
2020-03-08 04:41:42 +01:00
|
|
|
(dolist (register register-alist)
|
|
|
|
(if (or (markerp (cdr register))
|
|
|
|
(eq (nth 1 register) 'file-query))
|
2020-03-07 15:14:32 +01:00
|
|
|
(if register-quicknav-buffer-only
|
2020-03-08 04:41:42 +01:00
|
|
|
(when (register-quicknav--is-current-buffer? register)
|
|
|
|
(push register result))
|
|
|
|
(push register result))))
|
2020-03-02 10:32:01 +01:00
|
|
|
(sort result #'sort-registers))))
|
2020-02-19 15:58:45 +01:00
|
|
|
|
2020-03-07 19:56:54 +01:00
|
|
|
(defun register-quicknav--jump-to-register (next)
|
|
|
|
"Jump to next position register if NEXT is t, to previous otherwise."
|
2020-03-08 04:41:42 +01:00
|
|
|
(let* ((register-list (register-quicknav--registers))
|
|
|
|
(index (cl-position (register-quicknav--last-register) register-list))
|
2020-03-07 19:56:54 +01:00
|
|
|
(stop-searching))
|
2020-03-15 20:55:14 +01:00
|
|
|
(when index
|
2020-03-07 19:56:54 +01:00
|
|
|
(if next
|
2020-03-08 05:01:53 +01:00
|
|
|
(cl-incf index)
|
|
|
|
(cl-decf index)))
|
2020-03-07 19:56:54 +01:00
|
|
|
;; Try to find the position register closest to point.
|
2020-03-08 04:41:42 +01:00
|
|
|
(dolist (register register-list)
|
|
|
|
(when (register-quicknav--is-current-buffer? register)
|
|
|
|
(let ((register-pos (register-quicknav--position register)))
|
2020-03-07 19:56:54 +01:00
|
|
|
(if next
|
2020-03-08 12:02:52 +01:00
|
|
|
(when (and (not stop-searching)
|
|
|
|
(> register-pos (point)))
|
2020-03-08 05:01:53 +01:00
|
|
|
(setq index (cl-position register register-list)
|
|
|
|
stop-searching t))
|
|
|
|
(when (< register-pos (point))
|
|
|
|
(setq index (cl-position register register-list)))))))
|
2020-03-07 19:56:54 +01:00
|
|
|
(if index
|
2020-03-08 12:02:52 +01:00
|
|
|
(progn ; If index is invalid, set it to first or last register.
|
|
|
|
(when (or (>= index (length register-list))
|
|
|
|
(< index 0))
|
|
|
|
(if next
|
|
|
|
(setq index 0)
|
2020-03-08 05:48:48 +01:00
|
|
|
(setq index (- (length register-list) 1))))
|
2020-03-08 04:41:42 +01:00
|
|
|
(register-to-point (car (nth index register-list)))
|
|
|
|
(register-quicknav--last-register (nth index register-list)))
|
2020-03-08 17:09:43 +01:00
|
|
|
;; No suitable register found, jump to first register.
|
2020-03-08 04:41:42 +01:00
|
|
|
(register-to-point (car (car register-list)))
|
|
|
|
(register-quicknav--last-register (car register-list)))))
|
2020-03-07 19:56:54 +01:00
|
|
|
|
2020-02-28 06:17:18 +01:00
|
|
|
;;;###autoload
|
2020-03-01 06:42:50 +01:00
|
|
|
(defun register-quicknav-next-register ()
|
2020-02-19 20:01:33 +01:00
|
|
|
"Jump to next position register."
|
2020-02-19 15:58:45 +01:00
|
|
|
(interactive)
|
2020-03-07 19:56:54 +01:00
|
|
|
(register-quicknav--jump-to-register t))
|
2020-02-19 15:58:45 +01:00
|
|
|
|
2020-02-28 06:17:18 +01:00
|
|
|
;;;###autoload
|
2020-03-01 06:42:50 +01:00
|
|
|
(defun register-quicknav-prev-register ()
|
2020-02-19 20:01:33 +01:00
|
|
|
"Jump to previous position register."
|
2020-02-19 15:58:45 +01:00
|
|
|
(interactive)
|
2020-03-07 19:56:54 +01:00
|
|
|
(register-quicknav--jump-to-register nil))
|
2020-02-19 15:58:45 +01:00
|
|
|
|
2020-02-28 06:17:18 +01:00
|
|
|
;;;###autoload
|
2020-03-01 06:42:50 +01:00
|
|
|
(defun register-quicknav-clear-current-register ()
|
2020-03-07 19:56:54 +01:00
|
|
|
"Clear last jumped-to position register from `register-alist'."
|
2020-02-19 16:48:18 +01:00
|
|
|
(interactive)
|
2020-03-08 04:12:00 +01:00
|
|
|
(setq register-alist
|
|
|
|
(delq (register-quicknav--last-register) register-alist)))
|
2020-02-19 16:48:18 +01:00
|
|
|
|
2020-03-15 20:54:08 +01:00
|
|
|
;;;###autoload
|
|
|
|
(defun register-quicknav-point-to-unused-register ()
|
|
|
|
"Store current location of point in next unused register.
|
|
|
|
Searches the range between
|
|
|
|
`register-quicknav-unused-registers-begin' and
|
|
|
|
`register-quicknav-unused-registers-end'."
|
|
|
|
(interactive)
|
|
|
|
(let* ((begin register-quicknav-unused-registers-begin)
|
|
|
|
(end register-quicknav-unused-registers-end)
|
|
|
|
(char begin))
|
|
|
|
(while (and (get-register char)
|
|
|
|
(not (> char end)))
|
|
|
|
(cl-incf char))
|
|
|
|
(if (<= char end)
|
|
|
|
(point-to-register char)
|
|
|
|
(message "No unused register in the range %c - %c found." begin end))))
|
|
|
|
|
2020-02-19 15:58:45 +01:00
|
|
|
(provide 'register-quicknav)
|
|
|
|
;;; register-quicknav.el ends here
|