diff options
Diffstat (limited to '.config/emacs/lisp/evil-collection/modes/reftex')
| -rw-r--r-- | .config/emacs/lisp/evil-collection/modes/reftex/README.org | 75 | ||||
| -rw-r--r-- | .config/emacs/lisp/evil-collection/modes/reftex/evil-collection-reftex.el | 174 |
2 files changed, 249 insertions, 0 deletions
diff --git a/.config/emacs/lisp/evil-collection/modes/reftex/README.org b/.config/emacs/lisp/evil-collection/modes/reftex/README.org new file mode 100644 index 0000000..d6f1d49 --- /dev/null +++ b/.config/emacs/lisp/evil-collection/modes/reftex/README.org @@ -0,0 +1,75 @@ +* reftex + + Evil bindings for [[https://www.gnu.org/software/emacs/manual/html_node/reftex/index.html][reftex-mode]]. + +** Key bindings + +*** reftex-select-shared-map + + Used by =reftex-select-label-mode= and =reftex-select-bib-mode= (initial + state: normal). + + | Command | Original | Evil | + |------------------------------------------+----------+-------------------| + | =reftex-select-next= | =n= | =j= | + | =reftex-select-previous= | =p= | =k= | + | =reftex-select-next-heading= | n/a | =]]=, =gj=, =C-j= | + | =reftex-select-previous-heading= | n/a | =[[=, =gk=, =C-k= | + | =reftex-select-accept= | =RET= | =RET= | + | =reftex-select-callback= | =SPC= | =go= | + | =reftex-select-show-insertion-point= | =.= | =gO= | + | =reftex-select-read-label= | n/a | =TAB= | + | =reftex-select-quit= | =q= | =q=, =ZZ= | + | =evil-quit= | n/a | =ZQ= | + | =reftex-select-help= | =?= | =g?= | + | =reftex-select-jump= | n/a | =J= | + | =reftex-select-cycle-ref-style-forward= | n/a | =r= | + | =reftex-select-cycle-ref-style-backward= | n/a | =R= | + | =reftex-select-mark= | n/a | =m= | + | =reftex-select-unmark= | n/a | =u= | + + The keys =gr=, =c=, =s=, =x=, =X=, =S=, =o=, =O= dispatch back to + reftex's underlying =throw= protocol so the original selection actions + (rescan, reuse, switch label type, ref grouping, external xr, BibTeX + export) still work. + +*** reftex-toc-mode-map + + Initial state: normal. + + | Command | Original | Evil | + |-----------------------------------+-----------+------------| + | =reftex-toc-next= | =n= | =j= | + | =reftex-toc-previous= | =p= | =k= | + | =reftex-toc-view-line= | =SPC= | =go=, =gO= | + | =reftex-toc-goto-line-and-hide= | =RET= | =RET= | + | =reftex-toc-goto-line= | =TAB= | =TAB= | + | =reftex-toc-show-help= | =?= | =g?=, =?= | + | =reftex-toc-quit= | =q= | =q= | + | =reftex-toc-quit-and-kill= | =k= | =ZZ= | + | =evil-quit= | n/a | =ZQ= | + | =reftex-toc-rescan= | =r= | =gr= | + | =reftex-toc-Rescan= | =R= | =gR= | + | =reftex-toc-toggle-labels= | =l= | =l= | + | =reftex-toc-toggle-index= | =i= | =i= | + | =reftex-toc-toggle-context= | =c= | =c= | + | =reftex-toc-toggle-file-boundary= | =F= | =F= | + | =reftex-toc-rename-label= | =M-%= | =rl= | + | =reftex-toc-display-index= | =C-c >= | =zi= | + | =reftex-toc-external= | =x= | =x= | + | =reftex-toc-show-calling-point= | =.= | =.= | + | =reftex-toc-jump= | =z= | =J= | + | =reftex-toc-previous-heading= | =C-c C-p= | =[[= | + | =reftex-toc-next-heading= | =C-c C-n= | =]]= | + | =reftex-toc-promote= | =<= | =>= | + | =reftex-toc-demote= | =>= | =<= | + | =reftex-toc-toggle-follow= | =f= | =f= | + + Note: =>= and =<= are swapped relative to upstream so that =>= promotes + and =<= demotes; this matches the visual outline-shift direction. + +** Notes + + - =reftex-select-label-prompt=, =reftex-citation-prompt=, + =reftex-select-label-help=, =reftex-citation-help=, and + =reftex-toc-help= are rewritten to advertise the evil keys. diff --git a/.config/emacs/lisp/evil-collection/modes/reftex/evil-collection-reftex.el b/.config/emacs/lisp/evil-collection/modes/reftex/evil-collection-reftex.el new file mode 100644 index 0000000..274753f --- /dev/null +++ b/.config/emacs/lisp/evil-collection/modes/reftex/evil-collection-reftex.el @@ -0,0 +1,174 @@ +;;; evil-collection-reftex.el --- Bindings for `reftex' -*- lexical-binding: t -*- + +;; Copyright (C) 2017 Pierre Neidhardt + +;; Author: Maximiliano Sandoval <msandova@protonmail.com> +;; Maintainer: James Nguyen <james@jojojames.com> +;; Pierre Neidhardt <mail@ambrevar.xyz> +;; URL: https://github.com/emacs-evil/evil-collection +;; Version: 0.0.1 +;; Package-Requires: ((emacs "26.3")) +;; Keywords: evil, reftex, tools + +;; This file 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, or (at your +;; option) any later version. +;; +;; This file 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. +;; +;; For a full copy of the GNU General Public License +;; see <http://www.gnu.org/licenses/>. + +;;; Commentary: +;; Evil bindings for `reftex-mode'. + +;;; Code: +(require 'evil-collection) +(require 'reftex-ref nil t) +(require 'reftex-ref nil t) +(require 'reftex-cite nil t) +(require 'reftex-toc nil t) + +(defconst evil-collection-reftex-maps '(reftex-select-shared-map + reftex-toc-mode-map)) + +;; original code can be found in reftex-ref.el +(setq reftex-select-label-prompt + "Select: [RET]select [j]next [k]previous [gr]escan [go]context [q]uit [g?]help") + +;; original code can be found in reftex-cite.el +(setq reftex-citation-prompt + "Select: [RET]select [j]next [k]previous [q]uit [g?]help") + +;; original at reftex-ref.el +(setq reftex-select-label-help + " j / k Go to next/previous label (Cursor motion works as well) + [ / ] Go to previous/next section heading. + c Reuse last referenced label. + J Jump to a specific section, e.g. '3 J' jumps to section 3. + s Switch label type. + gr Reparse document. + go / gO Show context / Show insertion point. + S Switch to label menu of external document (with LaTeX package `xr'). + r / R Toggle \\ref <-> \\vref / Rotate \\ref <=> \\fref <=> \\Fref. + TAB Enter a label with completion. + m / M Mark/unmark entry. + x / X Put all marked entries into one/many \\ref commands. + q / RET Quit without referencing / Accept current label.") + +;; code can be found in reftex-cite.el +(setq reftex-citation-help + " j / k Go to next/previous entry (Cursor motion works as well). + go / gO Show citation / Show insertion point. + q Quit without inserting \\cite macro into buffer. + TAB Enter citation key with completion. + RET Accept current entry and create \\cite macro. + m / M Mark/Unmark the entry. + o / O Create BibTeX file with all marked / unmarked entries. + X / X Put all (marked) entries into one/many \\cite commands.") + +(setq reftex-toc-help + " AVAILABLE KEYS IN TOC BUFFER + ============================ + j / k next-line / previous-line + go Show the corresponding location of the LaTeX document. + TAB Goto the location and keep the TOC window. + RET Goto the location and hide the TOC window (also on mouse-2). + < / > Promote / Demote section, or all sections in region. + zi Display Index. With prefix arg, restrict index to current section. + q / ZZ Hide/Kill *toc* buffer, return to position of reftex-toc command. + l i c F Toggle display of [l]abels, [i]ndex, [c]ontext, [F]ile borders. + f Toggle follow mode + gr / gR Reparse the LaTeX document / Reparse entire LaTeX document. + . In other window, show position from where `reftex-toc' was called. + rl Global search and replace to rename label at point. + x Switch to TOC of external document (with LaTeX package `xr'). + J Jump to a specific section (e.g. '3 J' goes to section 3).") + +;;;###autoload +(defun evil-collection-reftex-setup () + "Set up `evil' bindings for `reftex'." + + (evil-set-initial-state 'reftex-select-label-mode 'normal) + (evil-set-initial-state 'reftex-select-bib-mode 'normal) + + (evil-collection-define-key 'normal 'reftex-select-shared-map + "j" 'reftex-select-next + "k" 'reftex-select-previous + (kbd "]]") 'reftex-select-next-heading + (kbd "[[") 'reftex-select-previous-heading + (kbd "gj") 'reftex-select-next-heading + (kbd "gk") 'reftex-select-previous-heading + (kbd "C-j") 'reftex-select-next-heading + (kbd "C-k") 'reftex-select-previous-heading + (kbd "RET") 'reftex-select-accept + "go" 'reftex-select-callback ;shows the point where the label is + "gr" (lambda nil "Press `?' during selection to find out + about this key" (interactive) (throw (quote myexit) 114)) ;reftex binds keys in a very arcane way using the number asigned by describe-char, in this case the value of "g" is 114 + "q" 'reftex-select-quit + "ZZ" 'reftex-select-quit + "ZQ" 'evil-quit + "g?" 'reftex-select-help + "c" (lambda nil "Press `?' during selection to find out + about this key." (interactive) (throw (quote myexit) 108)) + "J" 'reftex-select-jump ;; weird binding, using default + (kbd "<tab>") 'reftex-select-read-label + "s" (lambda nil "Press `?' during selection to find out + about this key." (interactive) (throw (quote myexit) 115)) + "x" (lambda nil "Press `?' during selection to find out + about this key." (interactive) (throw (quote myexit) 97)) + "X" (lambda nil "Press `?' during selection to find out + about this key." (interactive) (throw (quote myexit) 65)) + "S" (lambda nil "Press `?' during selection to find out + about this key." (interactive) (throw (quote myexit) 120)) + "r" 'reftex-select-cycle-ref-style-forward + "R" 'reftex-select-cycle-ref-style-backward + "gO" 'reftex-select-show-insertion-point + "o" (lambda nil "Press `?' during selection to find out + about this key." (interactive) (throw (quote myexit) 101)) + "O" (lambda nil "Press `?' during selection to find out + about this key." (interactive) (throw (quote myexit) 69)) + + ;; mark + "m" 'reftex-select-mark ; TODO: Need a mark toggle function. + "u" 'reftex-select-unmark) + + (evil-set-initial-state 'reftex-toc-mode 'normal) + + ;; This one is more involved, in reftex-toc.el, line 267 it shows the prompt + ;; string with the keybinds and I don't see any way of changing it to show evil-like binds. + (evil-collection-define-key 'normal 'reftex-toc-mode-map + "j" 'reftex-toc-next + "k" 'reftex-toc-previous + "go" 'reftex-toc-view-line + "gO" 'reftex-toc-view-line + (kbd "RET") 'reftex-toc-goto-line-and-hide + (kbd "<tab>") 'reftex-toc-goto-line + "g?" 'reftex-toc-show-help + "?" 'reftex-toc-show-help + "q" 'reftex-toc-quit + "ZZ" 'reftex-toc-quit-and-kill + "ZQ" 'evil-quit + "gr" 'reftex-toc-rescan + "gR" 'reftex-toc-Rescan + "l" 'reftex-toc-toggle-labels + "i" 'reftex-toc-toggle-index + "c" 'reftex-toc-toggle-context + "F" 'reftex-toc-toggle-file-boundary + "rl" 'reftex-toc-rename-label + "zi" 'reftex-toc-display-index + "x" 'reftex-toc-external + "." 'reftex-toc-show-calling-point + "J" 'reftex-toc-jump + (kbd "[[") 'reftex-toc-previous-heading + (kbd "]]") 'reftex-toc-next-heading + (kbd ">") 'reftex-toc-promote + (kbd "<") 'reftex-toc-demote + "f" 'reftex-toc-toggle-follow)) + +(provide 'evil-collection-reftex) +;;; evil-collection-reftex.el ends here |