ace-link-0.4.0/0000755000175000017500000000000012722761244013037 5ustar dogslegdogslegace-link-0.4.0/ace-link.el0000644000175000017500000003010112722761244015037 0ustar dogslegdogsleg;;; ace-link.el --- Quickly follow links ;; Copyright (C) 2014-2015 Oleh Krehel ;; Author: Oleh Krehel ;; URL: https://github.com/abo-abo/ace-link ;; Version: 0.4.0 ;; Package-Requires: ((avy "0.2.0")) ;; Keywords: convenience, links ;; This file is not part of GNU Emacs ;; 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 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. ;; For a full copy of the GNU General Public License ;; see . ;;; Commentary: ;; ;; This package offers an alternative to tabbing through links in ;; buffers, for instance, in an Info buffer. `avy' is used to turn ;; opening a link from an O(N) operation into an O(1). ;; ;; Use `ace-link-setup-default' to set up the default bindings, which currently ;; bind e.g. `ace-link-info' to "o", which was previously unbound and is ;; close to "l" (which by default goes back). ;; ;; Supported modes: `Info-mode', `help-mode', `org-mode', `eww-mode', ;; `gnus-article-mode', `Custom-mode', `woman-mode', `goto-address-mode'. ;;; Code: (require 'avy) ;;* `ace-link' ;;;###autoload (defun ace-link () "Call the ace link function for the current `major-mode'" (interactive) (cl-case major-mode (Info-mode (ace-link-info)) ((help-mode package-menu-mode) (ace-link-help)) (woman-mode (ace-link-woman)) (eww-mode (ace-link-eww)) ((compilation-mode grep-mode) (ace-link-compilation)) (gnus-mode (ace-link-gnus)) (org-mode (ace-link-org)) (Custom-mode (ace-link-org)) (t (error "%S isn't supported" major-mode)))) ;;* `ace-link-info' ;;;###autoload (defun ace-link-info () "Open a visible link in an `Info-mode' buffer." (interactive) (let ((pt (avy-with ace-link-info (avy--process (mapcar #'cdr (ace-link--info-collect)) #'avy--overlay-post)))) (ace-link--info-action pt))) (defun ace-link--info-action (pt) (when (numberp pt) (push-mark) (goto-char pt) (let ((we (window-end))) (while (not (ignore-errors (Info-follow-nearest-node))) (forward-char 1) (when (> (point) we) (error "Could not follow link")))))) (declare-function Info-follow-nearest-node "info") (declare-function Info-next-reference "info") (declare-function Info-try-follow-nearest-node "info") (declare-function Info-goto-node "info") (defun ace-link--info-current () "Return the node at point." (cons (cl-letf (((symbol-function #'Info-goto-node) (lambda (node _) node))) (Info-try-follow-nearest-node)) (point))) (defun ace-link--info-collect () "Collect the positions of visible links in the current `Info-mode' buffer." (let ((end (window-end)) points) (save-excursion (goto-char (window-start)) (when (ignore-errors (Info-next-reference) t) (push (ace-link--info-current) points) (Info-next-reference) (while (and (< (point) end) (> (point) (cdar points))) (push (ace-link--info-current) points) (Info-next-reference)) (nreverse points))))) ;;* `ace-link-help' ;;;###autoload (defun ace-link-help () "Open a visible link in a `help-mode' buffer." (interactive) (let ((pt (avy-with ace-link-help (avy--process (mapcar #'cdr (ace-link--help-collect)) #'avy--overlay-post)))) (ace-link--help-action pt))) (defun ace-link--help-action (pt) (when (numberp pt) (goto-char (1+ pt)) (push-button))) (defun ace-link--help-collect () "Collect the positions of visible links in the current `help-mode' buffer." (let ((skip (text-property-any (window-start) (window-end) 'button nil)) candidates) (save-excursion (while (setq skip (text-property-not-all skip (window-end) 'button nil)) (goto-char skip) (push (cons (button-label (button-at skip)) skip) candidates) (setq skip (text-property-any (point) (window-end) 'button nil)))) (nreverse candidates))) ;;* `ace-link-woman' ;;;###autoload (defun ace-link-woman () "Open a visible link in a `woman-mode' buffer." (interactive) (let ((pt (avy-with ace-link-woman (avy--process (mapcar #'cdr (ace-link--woman-collect)) #'avy--overlay-post)))) (ace-link--woman-action pt))) (defun ace-link--woman-action (pt) (when (number-or-marker-p pt) (goto-char (1+ pt)) (push-button))) (defun ace-link--woman-collect () "Collect all links visible in the current `woman-mode' buffer." (let ((end (window-end)) candidates) (save-excursion (goto-char (window-start)) (while (and (condition-case nil (forward-button 1) (error nil)) (< (point) end)) (push (cons (button-label (button-at (point))) (point)) candidates)) (nreverse candidates)))) ;;* `ace-link-eww' ;;;###autoload (defun ace-link-eww () "Open a visible link in an `eww-mode' buffer." (interactive) (let ((pt (avy-with ace-link-eww (avy--process (mapcar #'cdr (ace-link--eww-collect)) #'avy--overlay-post)))) (ace-link--eww-action pt))) (declare-function eww-follow-link "eww") (defun ace-link--eww-action (pt) (when (number-or-marker-p pt) (goto-char (1+ pt)) (eww-follow-link))) (defun ace-link--eww-collect () "Collect the positions of visible links in the current `eww' buffer." (save-excursion (save-restriction (narrow-to-region (window-start) (window-end)) (goto-char (point-min)) (let (beg end candidates) (setq end (if (get-text-property (point) 'help-echo) (point) (text-property-any (point) (point-max) 'help-echo nil))) (while (setq beg (text-property-not-all end (point-max) 'help-echo nil)) (goto-char beg) (setq end (text-property-any (point) (point-max) 'help-echo nil)) (push (cons (buffer-substring-no-properties beg end) beg) candidates)) (nreverse candidates))))) ;;* `ace-link-compilation' ;;;###autoload (defun ace-link-compilation () "Open a visible link in a `compilation-mode' buffer." (interactive) (let ((pt (avy-with ace-link-compilation (avy--process (mapcar #'cdr (ace-link--eww-collect)) #'avy--overlay-post)))) (ace-link--compilation-action pt))) (defun ace-link--compilation-action (pt) (when (number-or-marker-p pt) (goto-char (1+ pt)) (compile-goto-error))) (declare-function compile-goto-error "compile") ;;* `ace-link-gnus' ;;;###autoload (defun ace-link-gnus () "Open a visible link in a `gnus-article-mode' buffer." (interactive) (when (eq major-mode 'gnus-summary-mode) (gnus-summary-widget-forward 1)) (let ((pt (avy-with ace-link-gnus (avy--process (ace-link--gnus-collect) #'avy--overlay-post)))) (ace-link--gnus-action pt))) (defun ace-link--gnus-action (pt) (when (number-or-marker-p pt) (goto-char (1+ pt)) (widget-button-press (point)))) (declare-function widget-forward "wid-edit") (declare-function gnus-summary-widget-forward "gnus-sum") (declare-function widget-button-press "wid-edit") (defun ace-link--gnus-collect () "Collect the positions of visible links in the current gnus buffer." (require 'wid-edit) (let (candidates pt) (save-excursion (save-restriction (narrow-to-region (window-start) (window-end)) (goto-char (point-min)) (setq pt (point)) (while (progn (widget-forward 1) (> (point) pt)) (setq pt (point)) (when (or (plist-get (text-properties-at (point)) 'gnus-string) (plist-get (text-properties-at (point)) 'shr-url)) (push (point) candidates))) (nreverse candidates))))) ;;* `ace-link-org' ;;;###autoload (defun ace-link-org () "Open a visible link in an `org-mode' buffer." (interactive) (require 'org) (let ((pt (avy-with ace-link-org (avy--process (mapcar #'cdr (ace-link--org-collect)) #'avy--overlay-pre)))) (ace-link--org-action pt))) (declare-function org-open-at-point "org") (declare-function outline-invisible-p "outline") (defvar org-any-link-re) (defun ace-link--org-action (pt) (when (numberp pt) (goto-char pt) (org-open-at-point))) (defun ace-link--org-collect () (let ((end (window-end)) res) (save-excursion (goto-char (window-start)) (while (re-search-forward org-any-link-re end t) ;; Check that the link is visible. Look at the last character ;; position in the link ("...X]]") to cover links with and ;; without a description. (when (not (outline-invisible-p (- (match-end 0) 3))) (push (cons (buffer-substring-no-properties (match-beginning 0) (match-end 0)) (match-beginning 0)) res))) (nreverse res)))) ;;* `ace-link-custom' ;;;###autoload (defun ace-link-custom () "Open a visible link in an `Custom-mode' buffer." (interactive) (let ((pt (avy-with ace-link-custom (avy--process (ace-link--custom-collect) #'avy--overlay-pre)))) (ace-link--custom-action pt))) (declare-function Custom-newline "cus-edit") (defun ace-link--custom-action (pt) (when (number-or-marker-p pt) (goto-char pt) (Custom-newline (point)))) (defun ace-link--custom-collect () "Collect the positions of visible links in the current `Custom-mode' buffer." (let (candidates pt) (save-excursion (save-restriction (narrow-to-region (window-start) (window-end)) (goto-char (point-min)) (setq pt (point)) (while (progn (widget-forward 1) (> (point) pt)) (setq pt (point)) (when (get-char-property (point) 'button) (push (point) candidates))))) (nreverse candidates))) ;;* `ace-link-addr' ;;;###autoload (defun ace-link-addr () "Open a visible link in a goto-address buffer." (interactive) (let ((pt (avy-with ace-link-addr (avy--process (ace-link--addr-collect) #'avy--overlay-pre)))) (ace-link--addr-action pt))) (defun ace-link--addr-action (pt) (when (number-or-marker-p pt) (goto-char (1+ pt)) (goto-address-at-point))) (defun ace-link--addr-collect () (let (candidates) (dolist (overlay (overlays-in (window-start) (window-end))) (if (overlay-get overlay 'goto-address) (push (overlay-start overlay) candidates))) (nreverse candidates))) ;;* Bindings (defvar eww-link-keymap) (defvar eww-mode-map) (defvar custom-mode-map) ;;;###autoload (defun ace-link-setup-default (&optional key) "Bind KEY to appropriate functions in appropriate keymaps." (setq key (or key "o")) (eval-after-load "info" `(define-key Info-mode-map ,key 'ace-link-info)) (eval-after-load "compile" `(define-key compilation-mode-map ,key 'ace-link-compilation)) (eval-after-load "help-mode" `(define-key help-mode-map ,key 'ace-link-help)) (eval-after-load "woman" `(define-key woman-mode-map ,key 'ace-link-woman)) (eval-after-load "eww" `(progn (define-key eww-link-keymap ,key 'ace-link-eww) (define-key eww-mode-map ,key 'ace-link-eww))) (eval-after-load 'cus-edit `(progn (define-key custom-mode-map ,key 'ace-link-custom)))) (provide 'ace-link) ;;; ace-link.el ends here ace-link-0.4.0/Makefile0000644000175000017500000000036712722761244014505 0ustar dogslegdogslegemacs ?= emacs CASK = ~/.cask/bin/cask BEMACS = $(emacs) -batch -l targets/elpa.el all: compile test cask: $(shell EMACS=$(emacs) $(CASK) --verbose --debug) compile: $(BEMACS) -l targets/compile.el clean: rm -f *.elc .PHONY: all clean cask ace-link-0.4.0/Cask0000644000175000017500000000013412722761244013641 0ustar dogslegdogsleg(source gnu) (source melpa) (package-file "ace-link.el") (development (depends-on "avy"))ace-link-0.4.0/README.md0000644000175000017500000000376112722761244014325 0ustar dogslegdogsleg# ace-link **GNU Emacs package for selecting a link to jump to** ## What and why Currently, to jump to a link in an `Info-mode` or `help-mode` or `woman-mode` or `org-mode` or `eww-mode` or `compilation-mode` or `goto-address-mode` buffer, you can tab through the links to select the one you want. This is an O(N) operation, where the N is the amount of links. This package turns this into an O(1) operation, or at least O(log(N)) if you manage to squeeze thousands of links in one screen. It does so by assigning a letter to each link using [avy](https://github.com/abo-abo/avy). ## Install Either clone from here or install from [MELPA](http://melpa.milkbox.net/) (recommended). ## Setup Put this in your `~/.emacs`: (ace-link-setup-default) This will bind o to: - `ace-link-info` in `Info-mode` - `ace-link-help` in `help-mode` - `ace-link-woman` in `woman-mode` - `ace-link-eww` in `eww-mode` - `ace-link-compilation` in `compilation-mode` - `ace-link-custom` in `custom-mode-map` This shortcut is usually unbound and is very close to l which is the default shortcut to go back. To bind `ace-link-org`, you can use something like this: (define-key org-mode-map (kbd "M-o") 'ace-link-org) To bind `ace-link-gnus`, you can use something like this: (define-key gnus-summary-mode-map (kbd "M-o") 'ace-link-gnus) (define-key gnus-article-mode-map (kbd "M-o") 'ace-link-gnus) If you use `ert`, `ace-link-help` also works on `ert` results: (require 'ert) (define-key ert-results-mode-map "o" 'ace-link-help) To bind 'ace-link-addr' in all modes (useful when using `goto-address-mode` or `goto-address-prog-mode`): (global-set-key (kbd "M-o") 'ace-link-addr) ## Usage Just press o when you're in `Info-mode` or `help-mode` or `woman-mode` or `eww-mode` or `compilation-mode`. Here's a screencast of browsing Info using `ace-link-info`: ![gif][screencast-1] [screencast-1]: https://raw.githubusercontent.com/abo-abo/ace-link/gh-pages/screencast-1.gif ace-link-0.4.0/targets/0000755000175000017500000000000012722761244014510 5ustar dogslegdogslegace-link-0.4.0/targets/compile.el0000644000175000017500000000015112722761244016457 0ustar dogslegdogsleg(setq files '("ace-link.el")) (setq byte-compile--use-old-handlers nil) (mapc #'byte-compile-file files) ace-link-0.4.0/targets/elpa.el0000644000175000017500000000023012722761244015746 0ustar dogslegdogsleg(setq package-user-dir (expand-file-name (format ".cask/%s/elpa" emacs-version))) (package-initialize) (add-to-list 'load-path default-directory)